home *** CD-ROM | disk | FTP | other *** search
/ Video Toaster 4.0 / Video Toaster v4.0.iso / programs / documentation / toastnserial.doc < prev    next >
Text File  |  1993-12-13  |  3KB  |  58 lines
  1. ToastNSerial -- Serial control of the Video Toaster
  2. Arnie Cachelin © 1993 NewTek Inc.
  3.  
  4.   This release of the Video Toaster provides two methods for remote control
  5. of the Toaster using the serial port, an arexx script called
  6. ToasterSerialHost.rexx, and ToastNSerial.  ToastNSerial is a small program
  7. which waits for external commands coming in on the Amiga's RS-232 serial port,
  8. and passes whatever it gets to the Toaster's Switcher in a form it can
  9. understand.  The program will also return appropriate Switcher status or error
  10. information through the serial port.
  11.  
  12. Configuration
  13.   ToastNSerial can be launched from the AmigaDOS Command Shell (CLI), or
  14. from the Workbench graphical interface.  It will use the current system serial
  15. port preferences (set with the Prefs/Serial program), unless other settings
  16. are given at launch either by command line arguments for CLI launches, or
  17. by the ToolTypes array contained in the ToastNSerial icon in the case of a
  18. Workbench launch.  The [optional] command line parameters will
  19. be displayed if the program is run with the argument "-?".  They are:
  20. -b<baud> -s<settings> -d<device> -u<unit>.  Supported icon ToolTypes are
  21. similar, use: BAUD=<baud>, SETTINGS=<settings>, DEVICE=<device>,
  22. UNIT=<unit>.  Baud should be a communication rate between 300 and 38400,
  23. settings consist of data bits, parity, and stop bits in a format like "8N1"
  24. or "7E1".  The device and unit settings are only useful if you have multiple
  25. serial port hardware installed.  These parameters currently default to the
  26. Amiga's internal serial port (DEVICE=serial.port UNIT=0).
  27.  
  28. Program Input
  29.   ToastNSerial expects to receive valid ARexx commands for the Video
  30. Toaster, which are documented in the file SwitcherARexx.doc.
  31. The serial input to the Toaster should consist of one Toaster command
  32. per line. An ASCII 13 (CR) or 10 will terminate a line.  The call to the
  33. Switcher() function is not necessary, so if the command in an ARexx script
  34. looked like "Switcher(AUTO)" you should send the line "AUTO".  Multiple
  35. arguments are separated with commas (i.e. ARexx command
  36. "Switcher(FMSV,73,Art)" becomes line "FMSV,73,Art".  Note that all commands
  37. must be all UPPERCASE or they will fail. To shut down ToastNSerial, send it
  38. the command "EXIT".
  39.  
  40. Program output
  41.   ToastNSerial will write to the serial port after each operation has
  42. completed. To avoid losing commands, it is advisable to await the return
  43. before sending another line. If the command was successful, it will return
  44. either an "OK", or the result of the command.  If the command fails it
  45. returns "ERROR 10", if the Toaster isn't running, it says "No Toaster!".
  46. The text returned by this program does not have the carriage return at the
  47. end which it requires on its input.  When the program is launched, it will
  48. send "READY!" out to the serial port.  If you send the command "EXIT", the
  49. program will remove itself after sending the string "BYE BYE" to the serial
  50. port.  This is the only way to exit ToastNSerial.  The program will also
  51. print out the valid commands it sends to the Toaster.  These will appear in
  52. the command shell whence the program was launched.  This output can be
  53. redirected into a file which will have the guts of an ARexx script to
  54. duplicate the entire remote Toaster session.  Just combine it with the
  55. startup code in the ToasterSkeleton.rexx.  This is a useful debugging
  56. method with great potential.
  57.  
  58.